
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>Overview of DBM Utilities Module &#8212; Texas A&amp;M Oil spill / Outfall Calculator 2.1.0 documentation</title>
    <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
    <script src="../_static/jquery.js"></script>
    <script src="../_static/underscore.js"></script>
    <script src="../_static/doctools.js"></script>
    <script src="../_static/language_data.js"></script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="dbm_utilities.get_oil" href="../autodoc/dbm_utilities/dbm_utilities.get_oil.html" />
    <link rel="prev" title="dbm.gas_liq_eq" href="../autodoc/dbm/dbm.gas_liq_eq.html" />
   
  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="overview-of-dbm-utilities-module">
<h1>Overview of DBM Utilities Module<a class="headerlink" href="#overview-of-dbm-utilities-module" title="Permalink to this headline">¶</a></h1>
<dl class="field-list simple">
<dt class="field-odd">Release</dt>
<dd class="field-odd"><p>2.1</p>
</dd>
<dt class="field-even">Date</dt>
<dd class="field-even"><p>Jun 05, 2020</p>
</dd>
</dl>
<span class="target" id="module-dbm_utilities"></span><div class="section" id="discrete-bubble-model-utilities">
<h2>Discrete Bubble Model Utilities<a class="headerlink" href="#discrete-bubble-model-utilities" title="Permalink to this headline">¶</a></h2>
<p>This module contains utilities to create discrete bubble model (<code class="docutils literal notranslate"><span class="pre">dbm</span></code>) 
objects that are especially relevant to blowouts.  Among its various 
capabilities, this module provides an interface to the Oil Library 
distributed by NOAA ORR.</p>
</div>
<div class="section" id="module-functions">
<h2>Module Functions<a class="headerlink" href="#module-functions" title="Permalink to this headline">¶</a></h2>
<p>The functions contained in this module are listed as follows:</p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="../autodoc/dbm_utilities/dbm_utilities.get_oil.html#dbm_utilities.get_oil" title="dbm_utilities.get_oil"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_oil</span></code></a>(substance, q_oil, gor[, ca, fp_type])</p></td>
<td><p>Create a dbm.FluidMixture object for this oil and given flow rate</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../autodoc/dbm_utilities/dbm_utilities.load_tamoc_oil.html#dbm_utilities.load_tamoc_oil" title="dbm_utilities.load_tamoc_oil"><code class="xref py py-obj docutils literal notranslate"><span class="pre">load_tamoc_oil</span></code></a>(substance)</p></td>
<td><p>Create a dbm.FluidMixture object from the given TAMOC composition</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../autodoc/dbm_utilities/dbm_utilities.format_dbm_data.html#dbm_utilities.format_dbm_data" title="dbm_utilities.format_dbm_data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">format_dbm_data</span></code></a>(composition, M, Pc, Tc, …)</p></td>
<td><p>Format the chemical property data for use by the <cite>dbm</cite> module</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../autodoc/dbm_utilities/dbm_utilities.mix_gas_for_gor.html#dbm_utilities.mix_gas_for_gor" title="dbm_utilities.mix_gas_for_gor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mix_gas_for_gor</span></code></a>(dead_composition, …)</p></td>
<td><p>Create a live oil with a given gas to oil ratio (GOR)</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../autodoc/dbm_utilities/dbm_utilities.natural_gas.html#dbm_utilities.natural_gas" title="dbm_utilities.natural_gas"><code class="xref py py-obj docutils literal notranslate"><span class="pre">natural_gas</span></code></a>()</p></td>
<td><p>Define the composition of a natural gas</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../autodoc/dbm_utilities/dbm_utilities.gas_fraction.html#dbm_utilities.gas_fraction" title="dbm_utilities.gas_fraction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gas_fraction</span></code></a>(beta, gor_0, oil, mf_gas, …)</p></td>
<td><p>Compute the difference between the GOR of a mixture and a given GOR</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../autodoc/dbm_utilities/dbm_utilities.set_mass_fluxes.html#dbm_utilities.set_mass_fluxes" title="dbm_utilities.set_mass_fluxes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_mass_fluxes</span></code></a>(composition, mass_frac, …)</p></td>
<td><p>Compute the mass fluxes to achieve a desired oil flow rate</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../autodoc/dbm_utilities/dbm_utilities.load_adios_oil.html#dbm_utilities.load_adios_oil" title="dbm_utilities.load_adios_oil"><code class="xref py py-obj docutils literal notranslate"><span class="pre">load_adios_oil</span></code></a>(adios_id)</p></td>
<td><p>Load an oil from the NOAA OilLibrary (formerly, ADIOS)</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../autodoc/dbm_utilities/dbm_utilities.sequence_names.html#dbm_utilities.sequence_names" title="dbm_utilities.sequence_names"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sequence_names</span></code></a>(sara_names, name)</p></td>
<td><p>Add sequential counters to the pseudo-component name in sara_names</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../autodoc/dbm_utilities/dbm_utilities.get_solubility.html#dbm_utilities.get_solubility" title="dbm_utilities.get_solubility"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_solubility</span></code></a>(molecular_weight, density)</p></td>
<td><p>Estimate the solubility of each oil pseudo-component</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../autodoc/dbm_utilities/dbm_utilities.get_henry_constant.html#dbm_utilities.get_henry_constant" title="dbm_utilities.get_henry_constant"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_henry_constant</span></code></a>(solubility, …)</p></td>
<td><p>Estimate the Henry’s Law constant for each pseudo-component</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../autodoc/dbm_utilities/dbm_utilities.get_preos_params.html#dbm_utilities.get_preos_params" title="dbm_utilities.get_preos_params"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_preos_params</span></code></a>(Tb, M, rho)</p></td>
<td><p>Get the parameters required by the Ping Robinson Equation of State</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../autodoc/dbm_utilities/dbm_utilities.pedersen.html#dbm_utilities.pedersen" title="dbm_utilities.pedersen"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pedersen</span></code></a>(M[, composition])</p></td>
<td><p>Estimate the binary interaction coefficients</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../autodoc/dbm_utilities/dbm_utilities.compute_Vb.html#dbm_utilities.compute_Vb" title="dbm_utilities.compute_Vb"><code class="xref py py-obj docutils literal notranslate"><span class="pre">compute_Vb</span></code></a>(Vc)</p></td>
<td><p>Compute the molar volume at the boiling point</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../autodoc/dbm_utilities/dbm_utilities.Vc_tuning.html#dbm_utilities.Vc_tuning" title="dbm_utilities.Vc_tuning"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Vc_tuning</span></code></a>(mass_frac, composition, rho_data, …)</p></td>
<td><p>Tune Vc to get better density estimates</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../autodoc/dbm_utilities/dbm_utilities.print_chemdata.html#dbm_utilities.print_chemdata" title="dbm_utilities.print_chemdata"><code class="xref py py-obj docutils literal notranslate"><span class="pre">print_chemdata</span></code></a>(user_data, units[, chems])</p></td>
<td><p>Print a table of the chemical property data</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../autodoc/dbm_utilities/dbm_utilities.print_composition.html#dbm_utilities.print_composition" title="dbm_utilities.print_composition"><code class="xref py py-obj docutils literal notranslate"><span class="pre">print_composition</span></code></a>(composition, mass_frac)</p></td>
<td><p>Print a table of the chemical composition</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../autodoc/dbm_utilities/dbm_utilities.print_petroleum_props.html#dbm_utilities.print_petroleum_props" title="dbm_utilities.print_petroleum_props"><code class="xref py py-obj docutils literal notranslate"><span class="pre">print_petroleum_props</span></code></a>(comp, mass_frac, data, …)</p></td>
<td><p>Compute the gas and liquid properties of a petroleum fluid</p></td>
</tr>
</tbody>
</table>
</div>
</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">Texas A&M Oil spill / Outfall Calculator</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../user_manual.html">TAMOC User Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="../unit_tests.html">Unit Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../readme.html">Read Me File</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../index.html">Documentation overview</a><ul>
  <li><a href="../user_manual.html">TAMOC User Manual</a><ul>
      <li>Previous: <a href="../autodoc/dbm/dbm.gas_liq_eq.html" title="previous chapter">dbm.gas_liq_eq</a></li>
      <li>Next: <a href="../autodoc/dbm_utilities/dbm_utilities.get_oil.html" title="next chapter">dbm_utilities.get_oil</a></li>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, Scott A. Socolofsky.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="../_sources/modules/dbm_utils.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>